<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>CruiseControl.NET : Using CruiseControl.NET with Simian</title>
	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
    </head>

    <body>
	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
		    <tr>
			    <td valign="top" class="pagebody">
				    <div class="pageheader">
					    <span class="pagetitle">
                            CruiseControl.NET : Using CruiseControl.NET with Simian
                                                    </span>
				    </div>
				    <div class="pagesubheading">
					    This page last changed on Feb 21, 2007 by <font color="#0050B2">donn@donnfelker.com</font>.
				    </div>

				    <h2><a name="UsingCruiseControl.NETwithSimian-RunSimianaspartofyourintegration"></a>Run Simian as part of your integration</h2>


<h4><a name="UsingCruiseControl.NETwithSimian-RunSimianaspartofyourNAntbuild"></a>Run Simian as part of your NAnt build</h4>

<p>In order to get the results of Simian included in the CruiseControl.NET build results, you will need to include a call to simian.exe in your NAnt build file. We recommend you use a target like this:</p>

<p>For Versions prior to 2.2.14.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;target name=<span class="code-quote">"simian"</span> depends=<span class="code-quote">"compile"</span> description=<span class="code-quote">"finds duplicate code"</span>&gt;</span>
	<span class="code-tag">&lt;exec program=<span class="code-quote">"tools\simian\simian.exe"</span>&gt;</span>
		<span class="code-tag">&lt;arg value=<span class="code-quote">"-recurse=*.cs"</span>/&gt;</span>
		<span class="code-tag">&lt;arg value=<span class="code-quote">"-formatter=xml:build\log\simian.xml"</span>/&gt;</span>
	<span class="code-tag">&lt;/exec&gt;</span>
<span class="code-tag">&lt;/target&gt;</span></pre>
</div></div>
<p>For Version 2.2.14</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;target name=<span class="code-quote">"simian"</span> depends=<span class="code-quote">"compile"</span> description=<span class="code-quote">"finds duplicate code"</span>&gt;</span>
	<span class="code-tag">&lt;exec program=<span class="code-quote">"tools\simian\simian.exe"</span>&gt;</span>
		<span class="code-tag">&lt;arg value=<span class="code-quote">"-includes=**/*.cs"</span>/&gt;</span>
		<span class="code-tag">&lt;arg value=<span class="code-quote">"-formatter=xml:build\log\simian.xml"</span>/&gt;</span>
	<span class="code-tag">&lt;/exec&gt;</span>
<span class="code-tag">&lt;/target&gt;</span></pre>
</div></div>
<p>The above example runs simian on all .cs files from the project home directory. Run "simian" in order to see what command-line options are supported.</p>

<p>For a thorough example, look at the CruiseControl.NET source distribution and look at how we use Simian ourselves.</p>

<h4><a name="UsingCruiseControl.NETwithSimian-RunSimianasaCruiseControl.NETTask"></a>Run Simian as a CruiseControl.NET Task</h4>

<p>We don't currently support running Simian directly from CruiseControl.NET, but we plan on enabling this in a later release.</p>

<h2><a name="UsingCruiseControl.NETwithSimian-MergeSimianresultsintoyourCruiseControl.NETresults"></a>Merge Simian results into your CruiseControl.NET results</h2>

<p>The next step is to merge the Simian report file into the integration result using the <a href="File Merge Task.html" title="File Merge Task">File Merge Task</a>. Your <a href="CruiseControl.NET Server.html" title="CruiseControl.NET Server">CruiseControl.NET Server</a> config file will have something in it like :</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;tasks&gt;</span>
    <span class="code-tag">&lt;merge&gt;</span>
        <span class="code-tag">&lt;files&gt;</span>
            <span class="code-tag">&lt;file&gt;</span>d:\sourceforge\ccnet\build\log\unit-test.xml<span class="code-tag">&lt;/file&gt;</span>
            <span class="code-tag"><span class="code-comment">&lt;!-- Add your simian report file as follows --&gt;</span></span>
            <span class="code-tag">&lt;file&gt;</span>d:\sourceforge\ccnet\build\log\simian.xml<span class="code-tag">&lt;/file&gt;</span>
      	<span class="code-tag">&lt;/files&gt;</span>
    <span class="code-tag">&lt;/merge&gt;</span>
<span class="code-tag">&lt;/tasks&gt;</span></pre>
</div></div>

<h2><a name="UsingCruiseControl.NETwithSimian-ConfiguringyourReportingApplicationtodisplaySimianresults"></a>Configuring your Reporting Application to display Simian results</h2>

<p>For displaying the results, CruiseControl.NET currently supports Simian 2.2.3.</p>

<p>If you are using the <a href="Web Dashboard.html" title="Web Dashboard">Web Dashboard</a>, edit your <tt>dashboard.config</tt> file and include the <tt>SimianSummary.xsl</tt> file under the <tt>&lt;dashboard&gt;/&lt;plugins&gt;/&lt;buildPlugins&gt;/&lt;buildReportBuildPlugin&gt;/&lt;xslFileNames&gt;</tt> section like:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;xslFile&gt;</span>xsl\SimianSummary.xsl<span class="code-tag">&lt;/xslFile&gt;</span></pre>
</div></div>
<p>Also add the following to the <tt>&lt;dashboard&gt;/&lt;plugins&gt;/&lt;buildPlugins&gt;</tt> section as:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;xslReportBuildPlugin description=<span class="code-quote">"Simian Report"</span> actionName=<span class="code-quote">"SimianBuildReport"</span> xslFileName=<span class="code-quote">"xsl\SimianReport.xsl"</span> /&gt;</span></pre>
</div></div>

				    
                    			    </td>
		    </tr>
	    </table>
	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
			<tr>
				<td height="12" background="http://confluence.public.thoughtworks.org//images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
			</tr>
		    <tr>
			    <td align="center"><font color="grey">Document generated by Confluence on Sep 29, 2009 20:59</font></td>
		    </tr>
	    </table>
    </body>
</html>